Skip to content

@W-18909894 - add cursor rules for creating components#2702

Merged
snilakandan13 merged 15 commits intofeature/generated-project-cursor-rulesfrom
t/commerce/W-18909894/addCursorRules
Jul 14, 2025
Merged

@W-18909894 - add cursor rules for creating components#2702
snilakandan13 merged 15 commits intofeature/generated-project-cursor-rulesfrom
t/commerce/W-18909894/addCursorRules

Conversation

@snilakandan13
Copy link
Contributor

@snilakandan13 snilakandan13 commented Jul 1, 2025

@W-18909894

Added cursor rules for handling the component generation through cursor
These cursor go over the good practices and bad practices while creating components, making the LLM more aware of the PWA kit components and its structure

Description

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • Breaking change (could cause existing functionality to not work as expected)
  • [ x] Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

  • Removing a public function or component or prop
  • Adding a required argument to a function
  • Changing the data type of a function parameter or return value
  • Adding a new peer dependency to package.json

Changes

  • (change1)

How to Test-Drive This PR

  • (step1)

Checklists

General

  • Changes are covered by test cases
  • CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

  • [x ] There are no changes to UI

or...

Localization

  • Changes include a UI text update in the Retail React App (which requires translation)

@snilakandan13 snilakandan13 requested a review from a team as a code owner July 1, 2025 19:48
@cc-prodsec
Copy link
Collaborator

cc-prodsec commented Jul 1, 2025

🎉 Snyk checks have passed. No issues have been found so far.

security/snyk check is complete. No issues have been found. (View Details)

license/snyk check is complete. No issues have been found. (View Details)

@snilakandan13 snilakandan13 changed the title @W-18909894 - add cursor rules for creating Product components @W-18909894 - add cursor rules for creating components Jul 3, 2025
@snilakandan13 snilakandan13 changed the base branch from feature/pwa-developer-agent-only to feature/generated-project-cursor-rules July 11, 2025 15:03
@snilakandan13 snilakandan13 requested a review from yhsieh1 July 11, 2025 15:06
@snilakandan13 snilakandan13 added the skip changelog Skip the "Changelog Check" GitHub Actions step even if the Changelog.md files are not updated label Jul 11, 2025
## General Rules
Create components at: `**app/components/[component-name]/index.jsx`

## Template
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to provide this template? Not sure if this will help Cursor to create a component. We only focus on java script project, what if the project is created in TypeScript.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very generic, so true, I can remove it

@snilakandan13 snilakandan13 merged commit ff0cc39 into feature/generated-project-cursor-rules Jul 14, 2025
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip changelog Skip the "Changelog Check" GitHub Actions step even if the Changelog.md files are not updated

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants